Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing up docs #2322

Merged
merged 2 commits into from
Jan 26, 2025
Merged

Fixing up docs #2322

merged 2 commits into from
Jan 26, 2025

Conversation

rishiso
Copy link
Contributor

@rishiso rishiso commented Jan 23, 2025

Description

RTD builds have been failing for last several commits. This PR fixes the bug and resolves some of the warnings.

Associated / Resolved Issue

Resolves ClickUp card

Steps to Test

  1. Create Python env and activate
  2. pip install --upgrade --no-cache-dir pip setuptools
  3. pip install --upgrade --no-cache-dir sphinx
  4. pip install --exists-action=w --no-cache-dir -r docs/requirements.txt
  5. cd docs/source
  6. python -m sphinx -T -b html -d _build/doctrees -D language=en . html
  7. Open RTD from html folder

Expected result: Docs should be updated and working
Screenshot 2025-01-23 at 11 17 16 AM
^Updated installation docs

Copy link
Contributor

@sid-parikh sid-parikh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proof that it works: https://rj-rc-software.readthedocs.io/en/docs-fix/ (built from this branch)

Copy link
Contributor

@jacksherling jacksherling left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!

@rishiso rishiso merged commit 2a9452b into ros2 Jan 26, 2025
2 checks passed
@rishiso rishiso deleted the docs-fix branch January 26, 2025 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants